<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" href="../../../../style.css" type="text/css" media="screen">
<link rel="stylesheet" href="../../../../print.css" type="text/css" media="print">
<meta content="StateProxy,com.wemakedigital.state.model.StateProxy,ADD_RESPONDER,CALL,CALLED,CALL_CONFIRM,COMPLETE,CONFIRM,CONFIRM_RESPONSE,ENTER,ENTER_RESPONSE,ERROR,EVENT,EXIT,EXIT_RESPONSE,NAME,REMOVE_RESPONDER,STATE,actionResponse,callEvent,callStateChange,clearStates,conditionResponse,confirmResponse,createState,enterResponse,exitResponse,getCurrentEvent,getCurrentState,getInitialState,getLastState,getPreviousEvent,getState,getStateHistory,getTargetState,registerEvent,removeState,setInitialState" name="keywords">
<title>com.wemakedigital.state.model.StateProxy</title>
</head>
<body>
<script type="text/javascript" language="javascript" src="../../../../asdoc.js"></script><script type="text/javascript" language="javascript" src="../../../../cookies.js"></script><script type="text/javascript" language="javascript">
<!--
				asdocTitle = 'StateProxy - Make Digital ActionScript 3.0 Language Reference';
				var baseRef = '../../../../';
				window.onload = configPage;
			--></script>
<table style="display:none" id="titleTable" cellspacing="0" cellpadding="0" class="titleTable">
<tr>
<td align="left" class="titleTableTitle">API Documentation</td><td align="right" class="titleTableTopNav"><a onclick="loadClassListFrame('../../../../all-classes.html')" href="../../../../package-summary.html">All&nbsp;Packages</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../../../all-classes.html')" href="../../../../class-summary.html">All&nbsp;Classes</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../../../index-list.html')" href="../../../../all-index-A.html">Index</a>&nbsp;|&nbsp;<a href="../../../../index.html?com/wemakedigital/state/model/StateProxy.html&amp;com/wemakedigital/state/model/class-list.html" id="framesLink1">Frames</a><a onclick="parent.location=document.location" href="" style="display:none" id="noFramesLink1">No&nbsp;Frames</a></td><td rowspan="3" align="right" class="titleTableLogo"><img alt="Adobe Logo" title="Adobe Logo" class="logoImage" src="../../../../images/logo.jpg"></td>
</tr>
<tr class="titleTableRow2">
<td align="left" id="subTitle" class="titleTableSubTitle">Class&nbsp;StateProxy</td><td align="right" id="subNav" class="titleTableSubNav"><a href="#methodSummary">Methods</a>&nbsp;| <a href="#constantSummary">Constants</a></td>
</tr>
<tr class="titleTableRow3">
<td colspan="2">&nbsp;</td>
</tr>
</table>
<script type="text/javascript" language="javascript">
<!--
if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("Class StateProxy"); titleBar_setSubNav(true,false,false,false,false,false,true,false,false,false,false,false,false,false);}
--></script>
<div class="MainContent">
<table cellspacing="0" cellpadding="0" class="classHeaderTable">
<tr>
<td class="classHeaderTableLabel">Package</td><td><a onclick="javascript:loadClassListFrame('class-list.html')" href="package-detail.html">com.wemakedigital.state.model</a></td>
</tr>
<tr>
<td class="classHeaderTableLabel">Class</td><td class="classSignature">public class StateProxy</td>
</tr>
<tr>
<td class="classHeaderTableLabel">Inheritance</td><td class="inheritanceList">StateProxy <img class="inheritArrow" alt="Inheritance" title="Inheritance" src="../../../../images/inherit-arrow.gif"> org.puremvc.as3.multicore.patterns.proxy.Proxy</td>
</tr>
<tr>
<td class="classHeaderTableLabel">Implements</td><td>org.puremvc.as3.multicore.interfaces.IProxy</td>
</tr>
</table>
<p></p>
  The StateProxy state machine is responsible for maintaining application state.
  <p></p>
<br>
<hr>
</div>
<a name="methodSummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Public Methods</div>
<table id="summaryTableMethod" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#StateProxy()">StateProxy</a>()</div>
<div class="summaryTableDescription">
   Class constructor.</div>
</td><td class="summaryTableOwnerCol">StateProxy</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#actionResponse()">actionResponse</a>(action:String):void</div>
<div class="summaryTableDescription">
   Receives asynchrounous response from an action called by the current 
   event transition.</div>
</td><td class="summaryTableOwnerCol">StateProxy</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#callEvent()">callEvent</a>(event:String, confirm:Boolean = false):void</div>
<div class="summaryTableDescription">
   Calls a state machine event.</div>
</td><td class="summaryTableOwnerCol">StateProxy</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#callStateChange()">callStateChange</a>(state:String, confirm:Boolean = false):void</div>
<div class="summaryTableDescription">
   Calls a state change directly.</div>
</td><td class="summaryTableOwnerCol">StateProxy</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#clearStates()">clearStates</a>():void</div>
<div class="summaryTableDescription">
   Clears all existing states.</div>
</td><td class="summaryTableOwnerCol">StateProxy</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#conditionResponse()">conditionResponse</a>(condition:String, result:Boolean):void</div>
<div class="summaryTableDescription">
   Receives responses from transition condition commands.</div>
</td><td class="summaryTableOwnerCol">StateProxy</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#confirmResponse()">confirmResponse</a>(id:String, result:Boolean):void</div>
<div class="summaryTableDescription">
   Receives responses from a call confirmation.</div>
</td><td class="summaryTableOwnerCol">StateProxy</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#createState()">createState</a>(id:String):<a href="../model/State.html">State</a>
</div>
<div class="summaryTableDescription">
   Registers a new state with the state proxy.</div>
</td><td class="summaryTableOwnerCol">StateProxy</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#enterResponse()">enterResponse</a>(state:String, responder:<a href="../view/IStateResponder.html">IStateResponder</a>):void</div>
<div class="summaryTableDescription">
   Informs the proxy of a response to state enter notification.</div>
</td><td class="summaryTableOwnerCol">StateProxy</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#exitResponse()">exitResponse</a>(state:String, responder:<a href="../view/IStateResponder.html">IStateResponder</a>):void</div>
<div class="summaryTableDescription">
   Informs the proxy of a response to state exit notification.</div>
</td><td class="summaryTableOwnerCol">StateProxy</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#getCurrentEvent()">getCurrentEvent</a>():String</div>
<div class="summaryTableDescription">
   Gets the event currently being processed.</div>
</td><td class="summaryTableOwnerCol">StateProxy</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#getCurrentState()">getCurrentState</a>():<a href="../model/State.html">State</a>
</div>
<div class="summaryTableDescription">
   Gets the current state object.</div>
</td><td class="summaryTableOwnerCol">StateProxy</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#getInitialState()">getInitialState</a>():<a href="../model/State.html">State</a>
</div>
<div class="summaryTableDescription">
   Gets the initial states.</div>
</td><td class="summaryTableOwnerCol">StateProxy</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#getLastState()">getLastState</a>():String</div>
<div class="summaryTableDescription">
   Get the previous state.</div>
</td><td class="summaryTableOwnerCol">StateProxy</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#getPreviousEvent()">getPreviousEvent</a>():String</div>
<div class="summaryTableDescription">
   Gets the last processed event.</div>
</td><td class="summaryTableOwnerCol">StateProxy</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#getState()">getState</a>(id:String):<a href="../model/State.html">State</a>
</div>
<div class="summaryTableDescription">
   Gets a registered state object by id.</div>
</td><td class="summaryTableOwnerCol">StateProxy</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#getStateHistory()">getStateHistory</a>():Array</div>
<div class="summaryTableDescription">
   Get the previous states IDs.</div>
</td><td class="summaryTableOwnerCol">StateProxy</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#getTargetState()">getTargetState</a>():String</div>
<div class="summaryTableDescription">
   Gets the target state for the accepted transition.</div>
</td><td class="summaryTableOwnerCol">StateProxy</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#registerEvent()">registerEvent</a>(event:String):void</div>
<div class="summaryTableDescription">
   Registers an event with the StateEventCommand
   
   </div>
</td><td class="summaryTableOwnerCol">StateProxy</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#removeState()">removeState</a>(id:String):void</div>
<div class="summaryTableDescription">
   Removes a state from the state proxy.</div>
</td><td class="summaryTableOwnerCol">StateProxy</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#setInitialState()">setInitialState</a>(id:String):void</div>
<div class="summaryTableDescription">
   Sets the initial states.</div>
</td><td class="summaryTableOwnerCol">StateProxy</td>
</tr>
</table>
</div>
<a name="constantSummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Public Constants</div>
<table id="summaryTableConstant" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Constant</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#ADD_RESPONDER">ADD_RESPONDER</a> : String = "StateProxy.ADD_RESPONDER"<div class="summaryTableDescription">[static]
   Type sent with state notification by a state responder adding it as a 
   responder to changes in the state.</div>
</td><td class="summaryTableOwnerCol">StateProxy</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#CALL">CALL</a> : String = "StateProxy.CALL"<div class="summaryTableDescription">[static]
   Type sent with state or event notification telling the state machine 
   not to ask for confirmation.</div>
</td><td class="summaryTableOwnerCol">StateProxy</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#CALL_CONFIRM">CALL_CONFIRM</a> : String = "StateProxy.CALL_CONFIRM"<div class="summaryTableDescription">[static]
   Type sent with state or event notification telling the state machine 
   to ask for confirmation before calling.</div>
</td><td class="summaryTableOwnerCol">StateProxy</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#CALLED">CALLED</a> : String = "StateProxy.CALLED"<div class="summaryTableDescription">[static]
   Notification sent when a state change or state event is successfully called.</div>
</td><td class="summaryTableOwnerCol">StateProxy</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#COMPLETE">COMPLETE</a> : String = "StateProxy.COMPLETE"<div class="summaryTableDescription">[static]
   Notification sent when a state change or state event has completed.</div>
</td><td class="summaryTableOwnerCol">StateProxy</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#CONFIRM">CONFIRM</a> : String = "StateProxy.CONFIRM"<div class="summaryTableDescription">[static]
   Notification sent asking for confirmation before proceeding with an 
   event or state call.</div>
</td><td class="summaryTableOwnerCol">StateProxy</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#CONFIRM_RESPONSE">CONFIRM_RESPONSE</a> : String = "StateProxy.CONFIRM_RESPONSE"<div class="summaryTableDescription">[static]
   Notification sent in response to a StateProxy.CONFIRM notification.</div>
</td><td class="summaryTableOwnerCol">StateProxy</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#ENTER">ENTER</a> : String = "StateProxy.ENTER"<div class="summaryTableDescription">[static]
   Type sent with state notification by the state proxy instructing all 
   responders to enter the state.</div>
</td><td class="summaryTableOwnerCol">StateProxy</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#ENTER_RESPONSE">ENTER_RESPONSE</a> : String = "StateProxy.ENTER_RESPONSE"<div class="summaryTableDescription">[static]
   Type sent with state notification by a state responder informing the 
   state proxy that is has entered the state.</div>
</td><td class="summaryTableOwnerCol">StateProxy</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#ERROR">ERROR</a> : String = "StateProxy.ERROR"<div class="summaryTableDescription">[static]
   Notification sent when a state change or state event error occurs.</div>
</td><td class="summaryTableOwnerCol">StateProxy</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#EVENT">EVENT</a> : String = "StateProxy.EVENT"<div class="summaryTableDescription">[static]
   Type sent with CALLED, ERROR, or COMPLETE state notification.</div>
</td><td class="summaryTableOwnerCol">StateProxy</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#EXIT">EXIT</a> : String = "StateProxy.EXIT"<div class="summaryTableDescription">[static]
   Type sent with state notification by the state proxy instructing all 
   responders to exit the state.</div>
</td><td class="summaryTableOwnerCol">StateProxy</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#EXIT_RESPONSE">EXIT_RESPONSE</a> : String = "StateProxy.EXIT_RESPONSE"<div class="summaryTableDescription">[static]
   Type sent with state notification by a state responder informing the 
   state proxy that is has exited the state.</div>
</td><td class="summaryTableOwnerCol">StateProxy</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#NAME">NAME</a> : String = "StateProxy"<div class="summaryTableDescription">[static]
   Defines the name of the Proxy.</div>
</td><td class="summaryTableOwnerCol">StateProxy</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#REMOVE_RESPONDER">REMOVE_RESPONDER</a> : String = "StateProxy.REMOVE_RESPONDER"<div class="summaryTableDescription">[static]
   Type sent with state notification by a state responder removing it as 
   a responder to changes in the state.</div>
</td><td class="summaryTableOwnerCol">StateProxy</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#STATE">STATE</a> : String = "StateProxy.STATE"<div class="summaryTableDescription">[static]
   Type sent with CALLED, ERROR, or COMPLETE state notification.</div>
</td><td class="summaryTableOwnerCol">StateProxy</td>
</tr>
</table>
</div>
<script type="text/javascript" language="javascript">
<!--
showHideInherited();
--></script>
<div class="MainContent">
<a name="constructorDetail"></a>
<div class="detailSectionHeader">Constructor detail</div>
<a name="StateProxy()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">StateProxy</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">constructor</td>
</tr>
</table>
<div class="detailBody">
<code>public function StateProxy()</code><p>
   Class constructor.
   </p></div>
<a name="methodDetail"></a>
<div class="detailSectionHeader">Method detail</div>
<a name="actionResponse()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">actionResponse</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td>
</tr>
</table>
<div class="detailBody">
<code>public function actionResponse(action:String):void</code><p>
   Receives asynchrounous response from an action called by the current 
   event transition.
   
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">action</span>:String</code> &mdash; The action notification name.
   </td>
</tr>
</table>
</div>
<a name="callEvent()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">callEvent</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function callEvent(event:String, confirm:Boolean = false):void</code><p>
   Calls a state machine event.
   
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">event</span>:String</code> &mdash; The event notification name. 
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">confirm</span>:Boolean</code> (default = <code>false</code>)<code></code></td>
</tr>
</table>
</div>
<a name="callStateChange()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">callStateChange</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function callStateChange(state:String, confirm:Boolean = false):void</code><p>
   Calls a state change directly.
   
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">state</span>:String</code> &mdash; The event notification name. 
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">confirm</span>:Boolean</code> (default = <code>false</code>)<code></code></td>
</tr>
</table>
</div>
<a name="clearStates()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">clearStates</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function clearStates():void</code><p>
   Clears all existing states.
   </p></div>
<a name="conditionResponse()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">conditionResponse</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function conditionResponse(condition:String, result:Boolean):void</code><p>
   Receives responses from transition condition commands.
   
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">condition</span>:String</code> &mdash; The condition id.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">result</span>:Boolean</code> &mdash; The result of the condition, true or false.
   </td>
</tr>
</table>
</div>
<a name="confirmResponse()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">confirmResponse</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function confirmResponse(id:String, result:Boolean):void</code><p>
   Receives responses from a call confirmation.
   
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">id</span>:String</code> &mdash; The event or state id.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">result</span>:Boolean</code> &mdash; The result of the confirmation, true or false.
   </td>
</tr>
</table>
</div>
<a name="createState()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">createState</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function createState(id:String):<a href="../model/State.html">State</a></code><p>
   Registers a new state with the state proxy.
   
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">id</span>:String</code> &mdash; The state identifier and notification name.
   </td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../model/State.html">State</a></code> &mdash; 
                        The new State instance.
   
                        
                     </td>
</tr>
</table>
</div>
<a name="enterResponse()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">enterResponse</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function enterResponse(state:String, responder:<a href="../view/IStateResponder.html">IStateResponder</a>):void</code><p>
   Informs the proxy of a response to state enter notification.
      </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">state</span>:String</code> &mdash; The state identifier and notification name.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">responder</span>:<a href="../view/IStateResponder.html">IStateResponder</a></code> &mdash; An IStateResponder instance.
   </td>
</tr>
</table>
</div>
<a name="exitResponse()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">exitResponse</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function exitResponse(state:String, responder:<a href="../view/IStateResponder.html">IStateResponder</a>):void</code><p>
   Informs the proxy of a response to state exit notification.
      </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">state</span>:String</code> &mdash; The state identifier and notification name.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">responder</span>:<a href="../view/IStateResponder.html">IStateResponder</a></code> &mdash; An IStateResponder instance.
   </td>
</tr>
</table>
</div>
<a name="getCurrentEvent()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">getCurrentEvent</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function getCurrentEvent():String</code><p>
   Gets the event currently being processed.
   </p><p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code>String</code></td>
</tr>
</table>
</div>
<a name="getCurrentState()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">getCurrentState</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function getCurrentState():<a href="../model/State.html">State</a></code><p>
   Gets the current state object.
   
   </p><p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../model/State.html">State</a></code> &mdash; 
                        The State instance.
   
                        
                     </td>
</tr>
</table>
</div>
<a name="getInitialState()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">getInitialState</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function getInitialState():<a href="../model/State.html">State</a></code><p>
   Gets the initial states.
   
   </p><p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../model/State.html">State</a></code> &mdash; 
                        The State instance.
   
                        
                     </td>
</tr>
</table>
</div>
<a name="getLastState()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">getLastState</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function getLastState():String</code><p>
   Get the previous state.
   
   </p><p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code>String</code> &mdash; A state ID.
   </td>
</tr>
</table>
</div>
<a name="getPreviousEvent()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">getPreviousEvent</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function getPreviousEvent():String</code><p>
   Gets the last processed event.
   </p><p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code>String</code></td>
</tr>
</table>
</div>
<a name="getState()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">getState</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function getState(id:String):<a href="../model/State.html">State</a></code><p>
   Gets a registered state object by id. 
   
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">id</span>:String</code> &mdash; The state identifier and notification name.
   </td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../model/State.html">State</a></code> &mdash; 
                        The State instance.
   
                        
                     </td>
</tr>
</table>
</div>
<a name="getStateHistory()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">getStateHistory</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function getStateHistory():Array</code><p>
   Get the previous states IDs.
   
   </p><p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code>Array</code> &mdash; An Array of state IDs.
   </td>
</tr>
</table>
</div>
<a name="getTargetState()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">getTargetState</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function getTargetState():String</code><p>
   Gets the target state for the accepted transition.
   </p><p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code>String</code></td>
</tr>
</table>
</div>
<a name="registerEvent()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">registerEvent</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function registerEvent(event:String):void</code><p>
   Registers an event with the StateEventCommand
   
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">event</span>:String</code> &mdash; The event notification name. 
   </td>
</tr>
</table>
</div>
<a name="removeState()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">removeState</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function removeState(id:String):void</code><p>
   Removes a state from the state proxy.
   
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">id</span>:String</code> &mdash; The state identifier and notification name.
   </td>
</tr>
</table>
</div>
<a name="setInitialState()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">setInitialState</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function setInitialState(id:String):void</code><p>
   Sets the initial states.
   
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">id</span>:String</code> &mdash; The state identifier and notification name.
   </td>
</tr>
</table>
</div>
<a name="constantDetail"></a>
<div class="detailSectionHeader">Constant detail</div>
<a name="ADD_RESPONDER"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">ADD_RESPONDER</td><td class="detailHeaderType">constant</td>
</tr>
</table>
<div class="detailBody">
<code>public static const ADD_RESPONDER:String = "StateProxy.ADD_RESPONDER"</code><p>
   Type sent with state notification by a state responder adding it as a 
   responder to changes in the state.
   </p></div>
<a name="CALL"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">CALL</td><td class="detailHeaderType">constant</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public static const CALL:String = "StateProxy.CALL"</code><p>
   Type sent with state or event notification telling the state machine 
   not to ask for confirmation. 
   </p></div>
<a name="CALL_CONFIRM"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">CALL_CONFIRM</td><td class="detailHeaderType">constant</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public static const CALL_CONFIRM:String = "StateProxy.CALL_CONFIRM"</code><p>
   Type sent with state or event notification telling the state machine 
   to ask for confirmation before calling.
   </p></div>
<a name="CALLED"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">CALLED</td><td class="detailHeaderType">constant</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public static const CALLED:String = "StateProxy.CALLED"</code><p>
   Notification sent when a state change or state event is successfully called.
   </p></div>
<a name="COMPLETE"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">COMPLETE</td><td class="detailHeaderType">constant</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public static const COMPLETE:String = "StateProxy.COMPLETE"</code><p>
   Notification sent when a state change or state event has completed.
   </p></div>
<a name="CONFIRM"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">CONFIRM</td><td class="detailHeaderType">constant</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public static const CONFIRM:String = "StateProxy.CONFIRM"</code><p>
   Notification sent asking for confirmation before proceeding with an 
   event or state call.
   </p></div>
<a name="CONFIRM_RESPONSE"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">CONFIRM_RESPONSE</td><td class="detailHeaderType">constant</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public static const CONFIRM_RESPONSE:String = "StateProxy.CONFIRM_RESPONSE"</code><p>
   Notification sent in response to a StateProxy.CONFIRM notification.
   </p></div>
<a name="ENTER"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">ENTER</td><td class="detailHeaderType">constant</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public static const ENTER:String = "StateProxy.ENTER"</code><p>
   Type sent with state notification by the state proxy instructing all 
   responders to enter the state.
   </p></div>
<a name="ENTER_RESPONSE"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">ENTER_RESPONSE</td><td class="detailHeaderType">constant</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public static const ENTER_RESPONSE:String = "StateProxy.ENTER_RESPONSE"</code><p>
   Type sent with state notification by a state responder informing the 
   state proxy that is has entered the state.
   </p></div>
<a name="ERROR"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">ERROR</td><td class="detailHeaderType">constant</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public static const ERROR:String = "StateProxy.ERROR"</code><p>
   Notification sent when a state change or state event error occurs.
   </p></div>
<a name="EVENT"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">EVENT</td><td class="detailHeaderType">constant</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public static const EVENT:String = "StateProxy.EVENT"</code><p>
   Type sent with CALLED, ERROR, or COMPLETE state notification.
   </p></div>
<a name="EXIT"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">EXIT</td><td class="detailHeaderType">constant</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public static const EXIT:String = "StateProxy.EXIT"</code><p>
   Type sent with state notification by the state proxy instructing all 
   responders to exit the state.
   </p></div>
<a name="EXIT_RESPONSE"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">EXIT_RESPONSE</td><td class="detailHeaderType">constant</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public static const EXIT_RESPONSE:String = "StateProxy.EXIT_RESPONSE"</code><p>
   Type sent with state notification by a state responder informing the 
   state proxy that is has exited the state.
   </p></div>
<a name="NAME"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">NAME</td><td class="detailHeaderType">constant</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public static const NAME:String = "StateProxy"</code><p>
   Defines the name of the Proxy.
   </p></div>
<a name="REMOVE_RESPONDER"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">REMOVE_RESPONDER</td><td class="detailHeaderType">constant</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public static const REMOVE_RESPONDER:String = "StateProxy.REMOVE_RESPONDER"</code><p>
   Type sent with state notification by a state responder removing it as 
   a responder to changes in the state.
   </p></div>
<a name="STATE"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">STATE</td><td class="detailHeaderType">constant</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public static const STATE:String = "StateProxy.STATE"</code><p>
   Type sent with CALLED, ERROR, or COMPLETE state notification.
   </p></div>
<br>
<br>
<hr>
<br>
<p></p>
<center class="copyright"> 
</center>
</div>
</body>
</html>
<!-- -->
